SNMP Parameters

The SNMP parameters are described in the table below.

SNMP Parameters

Parameter

Description

'Disable SNMP'

configure system > snmp settings > disable

[DisableSNMP]

Enables and disables SNMP.

[0] No = (Default) SNMP is enabled.
[1] Yes = SNMP is disabled.

Note:

For the parameter to take effect, a device reset is required.

configure system > snmp settings > enable-advanced-mode

[EnableSnmpAdvancedMode]

Enables the SNMP advanced mode.

[0] = (Default) SNMP basic mode.
[1] = SNMP advanced mode.

For more information on SNMP advanced mode, see Enabling the SNMP View-based Access Control Model.

'IPv4 Interface Name'

configure system > snmp settings > snmp-server-interface > ipv4-snmp-network-source

[SNMPInterface_InterfaceName]

Assigns an alias name representing an IPv4 VRF or IP address of the source network interface that is used to bind to the SNMP application..

'IPv6 Interface Name'

configure system > snmp settings > snmp-server-interface-ipv6 > ipv6-snmp-network-source

[SNMPIPv6Interface_InterfaceName]

Assigns an alias name representing an IPv6 VRF or IP address of the source network interface that is used to bind to the SNMP application..

configure system > snmp settings > port

[SNMPPort]

Defines the device's local (LAN) UDP port used for SNMP Get/Set commands.

The range is 100 to 3999. The default port is 161.

Note: For the parameter to take effect, a device reset is required.

[ChassisPhysicalAlias]

Defines the 'alias' name object for the physical entity as specified by a network manager, and provides a non-volatile 'handle' for the physical entity.
The valid range is a string of up to 255 characters.

[ChassisPhysicalAssetID]

Defines the user-assigned asset tracking identifier object for the device's chassis as specified by OVOC, and provides non-volatile storage of this information.
The valid range is a string of up to 255 characters.

[ifAlias]

Defines the textual name of the interface. The value is equal to the ifAlias SNMP MIB object.
The valid range is a string of up to 64 characters.

configure system > snmp trap > auto-send-keep-alive

[SendKeepAliveTrap]

Enables the device to send NAT keep-alive traps to the port of the SNMP network management station (e.g., AudioCodes OVOC). This is used for NAT traversal, and allows SNMP communication with OVOC management platform, located in the WAN, when the device is located behind NAT. It is needed to keep the NAT pinhole open for the SNMP messages sent from OVOC to the device. The device sends the trap periodically - every 9/10 of the time configured by the NATBindingDefaultTimeout parameter. The trap that is sent is acKeepAlive. For more information on the SNMP trap, refer to the SNMP Reference Guide.

[0] = (Default) Disable
[1] = Enable

To configure the port number, use the KeepAliveTrapPort parameter.

Note: For the parameter to take effect, a device reset is required.

[KeepAliveTrapPort]

Defines the port of the SNMP network management station to which the device sends keep-alive traps.

The valid range is 0 - 65534. The default is port 162.

To enable NAT keep-alive traps, use the [SendKeepAliveTrap] parameter.

[PM_EnableThresholdAlarms]

Enables the sending of the SNMP trap event acPerformanceMonitoringThresholdCrossing, which is sent every time the threshold (high or low) of a Performance Monitored object (e.g., acPMSIPSBCAttemptedCallsTable) is crossed.

[0] = (Default) Disable
[1] = Enable

Note: Once enabled, you can change the low and high threshold values per performance monitored object. For more information, see the SNMP Reference Guide for Gateways-SBCs-MSBRs.

'Call Duration for Short Calls'

configure voip > sbc settings > short-call-seconds

[ShortCallSeconds]

Defines the duration (in seconds) of an SBC call for it to be considered as a short call and thus, included in the count of the performance monitoring SNMP MIBs for short calls (acPMSBCInShortCallsTable, acPMSBCOutShortCallsTable, acPMSBCSRDInShortCallsTable, acPMSBCSRDOutShortCallsTable, acPMSBCIPGroupInShortCallsTable, and acPMSBCIPGroupOutShortCallsTable).

The valid value is 0 to 60. The default is 2. A value of 0 indicates calls of zero duration, which are calls that do not pass the device's Classification, Manipulation or Routing stages.

Note: The parameter is applicable only to the SBC application.

configure voip > gateway advanced > attempted-call-count-on-start

[AttemptedCallCountOnStart]

Enables the device to count calls only at call start stage for SNMP performance monitoring MIBs that count attempted calls (IP-to-Tel and Tel-to-IP), for example, acPMSIPAttemptedCallsTable.

[0] = (Default) Disable. For attempted calls performance monitoring, the device counts all calls after they are terminated (e.g., SIP BYE or PSTN Disconnect). It's not important if the call was successfully established or not.
[1] = Enable. For attempted calls performance monitoring, thedevice counts all calls at call start stage (when initiated) - before call is established (e.g., SIP INVITE or PSTN Ringing). It's not important if the call was successfully established or not.

Note: The parameter is applicable only to the Gateway application.

configure system > snmp settings > sys-oid

[SNMPSysOid]

Defines the SNMP MIB OID for the base product system.

The default is 1.3.6.1.4.1.5003.8.1.1.

Note:

For the parameter to take effect, a device reset is required.
The device automatically adds the device’s unique product identifier number at the end of your OID.

[SNMPTrapEnterpriseOid]

Defines the SNMP MIB OID for the Trap Enterprise.

The default is 1.3.6.1.4.1.5003.9.10.1.21.

Note:

For the parameter to take effect, a device reset is required.
The device automatically adds the device’s unique product identifier number at the end of your OID.

[acUserInputAlarmDescription]

Defines the description of the input alarm.

[acUserInputAlarmSeverity]

Defines the severity of the input alarm.

[AlarmHistoryTableMaxSize]

Defines the maximum number of rows in the Alarm History table. The parameter can be controlled by the Config Global Entry Limit MIB (located in the Notification Log MIB).

The valid range is 50 to 1000. The default is 500.

Note: For the parameter to take effect, a device reset is required.

[ActiveAlarmTableMaxSize]

Defines the maximum number of currently active alarms that can be displayed in the Active Alarms table. When the table reaches this user-defined maximum capacity (i.e., full), the device sends the SNMP trap event, acActiveAlarmTableOverflow. If the table is full and a new alarm is raised by the device, the new alarm is not displayed in the table.

The valid range is 50 to 300. The default is 120.

For more information on the Active Alarms table, see Viewing Active Alarms.

Note:

For the parameter to take effect, a device reset is required.
To clear the acActiveAlarmTableOverflow trap, you must reset the device. The reset also deletes all the alarms in the Active Alarms table.

configure voip > gateway analog fxs-setting fxs-offhook-timeout-alarm

[FXSOffhookTimeoutAlarm]

Defines the duration (in seconds) of an FXS phone in off-hook state after which the device sends the SNMP alarm, acAnalogLineLeftOffhookAlarm. The device starts this timer once the reorder tone begins playing when the phone goes off-hook. The alarm is cleared when the phone's hook-flash button is pressed or the phone returns to on-hook state.

The valid value is 0 to 180,000. The default is 0, meaning that this alarm is not sent when the phone goes off-hook.

Note:

The parameter is applicable only to FXS interfaces.
The parameter's setting is applied only to phones that go off-hook after you have configured the parameter.

[ContextEngineID]

Defines the contextEngineID as mentioned in RFC 3411. An SNMP context is a collection of management information accessible by an SNMP entity. An item of management information may exist in more than one context and an SNMP entity potentially has access to many contexts. A context is identified by the snmpEngineID value of the entity hosting the management information (also called a contextEngineID) and a context name that identifies the specific context (also called a contextName).

Note:

For the parameter to take effect, a device reset is required.

configure system > snmp settings > engine-id

[SNMPEngineIDString]

Defines the SNMP engine ID for SNMPv2/SNMPv3 agents. This is used for authenticating a user attempting to access the SNMP agent on the device.

The ID can be a string of up to 36 characters. The default is 00:00:00:00:00:00:00:00:00:00:00:00 (12 Hex octets characters). The provided key must be set with 12 Hex values delimited by a colon (":") in the format xx:xx:...:xx. For example, 00:11:22:33:44:55:66:77:88:99:aa:bb

Note:

For the parameter to take effect, a device reset is required.
Before setting the parameter, all SNMPv3 users must be deleted; otherwise, the parameter setting is ignored.
If the supplied key does not pass validation of the 12 Hex values input or it is set with the default value, the engine ID is generated according to RFC 3411.

'Activity Trap'

configure troubleshoot > activity-trap

[EnableActivityTrap]

Enables the device to send an SNMP trap to notify of Web user activities in the Web interface. The activities to report are configured by the [ActivityListToLog] parameter (see Reporting Management User Activities).

[0] Disable (default)
[1] Enable

[LinkUpDownTrapIfIndexSuffixEnable]

Enables the device to include the index of the interface (ifIndex) in the sent Link Up (OID 1.3.6.1.6.3.1.1.5.4) or Link Down (OID 1.3.6.1.6.3.1.1.5.3) SNMP trap.

[0] = Disable - traps are sent without the index of the interface.
[1] = (Default) Enable - index of the interface is included in the sent traps.

configure system > snmp settings > enable-authentication-trap

[EnableSnmpAuthenticationTrap]

Disables the sending of the Authentication Failure SNMP trap (authenticationFailure, OID 1.3.6.1.6.3.1.1.5.5).

[0] = Disable - trap is not sent.
[1] = (Default) Enable - trap is sent.

SNMP Community String Parameters

'Trap Community String'

configure system > snmp trap > community-string

[SNMPTrapCommunityStringPassword]

Defines the community string for SNMP traps.

For more information, see Configuring SNMP Community String for Traps.

Note: The parameter cannot be configured with wide characters.